﻿/*
 * Copyright 2012 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Copyright (c) 2020 The Dotnetty-Span-Fork Project (cuteant@outlook.com)
 *
 *   https://github.com/cuteant/dotnetty-span-fork
 *
 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */

namespace DotNetty.Codecs.Http.WebSockets
{
    using DotNetty.Buffers;
    using DotNetty.Common.Utilities;

    /// <summary>
    /// Base class for web socket frames.
    /// </summary>
    public abstract class WebSocketFrame : DefaultByteBufferHolder
    {
        internal readonly Opcode Opcode;

        // Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
        // final fragment.
        readonly bool finalFragment;

        // RSV1, RSV2, RSV3 used for extensions
        readonly int rsv;

        protected WebSocketFrame(IByteBuffer binaryData) 
            : this(true, 0, binaryData)
        {
        }

        protected WebSocketFrame(bool finalFragment, int rsv, IByteBuffer binaryData)
            : base(binaryData)
        {
            this.finalFragment = finalFragment;
            this.rsv = rsv;
        }

        internal WebSocketFrame(bool finalFragment, int rsv, Opcode opcode, IByteBuffer binaryData)
            : base(binaryData)
        {
            this.finalFragment = finalFragment;
            this.rsv = rsv;
            this.Opcode = opcode;
        }

        /// <summary>
        /// Flag to indicate if this frame is the final fragment in a message. The first fragment (frame)
        /// may also be the final fragment.
        /// </summary>
        public bool IsFinalFragment => this.finalFragment;

        /// <summary>
        /// RSV1, RSV2, RSV3 used for extensions
        /// </summary>
        public int Rsv => this.rsv;

        /// <inheritdoc />
        public override string ToString() => StringUtil.SimpleClassName(this) + "(data: " + this.ContentToString() + ')';
    }
}
